.TH "PAPI_query_named_event" 3 "Tue Jan 15 2013" "Version 5.1.0.2" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_query_named_event \- 
.PP
Query if a named PAPI event exists.  

.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 
\fBC Interface:\fP
.RS 4
#include <\fBpapi.h\fP> 
.br
 int PAPI_query_named_event(char *EventName);
.RE
.PP
PAPI_query_named_event() asks the PAPI library if the PAPI named event can be counted on this architecture. If the event CAN be counted, the function returns PAPI_OK. If the event CANNOT be counted, the function returns an error code. This function also can be used to check the syntax of native and user events.
.PP
\fBParameters:\fP
.RS 4
\fIEventName\fP -- a defined event such as PAPI_TOT_INS.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIPAPI_EINVAL\fP One or more of the arguments is invalid. 
.br
\fIPAPI_ENOEVNT\fP The PAPI preset is not available on the underlying hardware.
.RE
.PP
\fBExamples\fP
.RS 4

.PP
.nf
 int retval;
 // Initialize the library
 retval = PAPI_library_init(PAPI_VER_CURRENT);
 if (retval != PAPI_VER_CURRENT) {
   fprintf(stderr,\'PAPI library init error!\\n\');
   exit(1); 
 }
 if (PAPI_query_named_event('PAPI_TOT_INS') != PAPI_OK) {
   fprintf(stderr,\'No instruction counter? How lame.\\n\');
   exit(1);
 }

.fi
.PP
.RE
.PP
.PP
\fBSee also:\fP
.RS 4
\fBPAPI_query_event\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for PAPI from the source code.
